Install and activate customized process packages using the Package Loader
You can install and activate customized process packages with the command line tool Scanjour.Process.PackageLoader.exe. The tool is part of the WorkZone Process installation.
After installation, the Package Loader tool is located here: ..\KMD\WorkZone\Process\Bin.
The minimal syntax of the command line is:
Scanjour.Process.PackageLoader.exe /uri:<uri> /package:<package>
The specified package will be loaded into the database that is identified by the /uri parameter.
Required parameters
Depending on the authentication method that is used, you need to specify either Windows or OAuth specific parameters.
| Parameters | Description |
|---|---|
|
Windows authentication |
|
/uri:<uri>
|
The WorkZone Content Server URI where WorkZone Process is installed. |
/package:<package>
|
The name of the package to be loaded. |
| OAuth authentication |
|
/uri:<uri>
|
The WorkZone Content Server URI where WorkZone Process is installed. |
/package:<package>
|
The name of the package to be loaded. |
|
/ |
The OAuth server URI. |
|
|
The WorkZone Process client ID (WZP). |
|
/oauth_client_secret |
The WorkZone Process client secret. |
Optional parameters
Optional parameters apply to both Windows and OAuth authentication.
| Parameters | Description |
|---|---|
</credentials=<credentials>
|
Windows credentials of the WorkZone user by which the package will be loaded. |
<login>
|
The name of the Windows account to be used for accessing WorkZone Content Server. |
<domain>
|
The name of the realm (domain or computer) that the account belongs to. |
<password>
|
The password required for the account authentication. |
<odatapath>
|
The relative path to the OData endpoint that will be used for loading the package data. |
<defaultdisabled>
|
If the package is related to a feature in the Version table, this argument can disable this feature by default. |
|
|
If the package is related to a feature in the Version table, this argument can enable this feature by default. |
|
|
Shows help information. |
Example: Windows authentication
Scanjour.Process.PackageLoader.exe /uri:https://db01 /package:MinisterialServices.wzp
Scanjour.Process.PackageLoader.exe /uri:https://db01 /package:Package.wzp /credentials:admin@domain/password
Scanjour.Process.PackageLoader.exe /uri:https://db01 /package:Package.wzp /odatapath:/odata/v3
Scanjour.Process.PackageLoader.exe /uri:https://db01 /package:Package.wzp /defaultdisabled
Scanjour.Process.PackageLoader.exe /uri:https://db01 /package:Package.wzp /defaultenabled
Example: OAuth authentication
Scanjour.Process.PackageLoader.exe /uri:https://db01 /package:Basis.wzp /oauth_server_uri:https://db01/oauth2 /ouath_client_id:WZP /oauth_client_secret:secret
Important: After deploying a new package, you must either restart IIS or recycle the WzpSvc application pool on all relevant web servers.
Display customized process packages in WorkZone Configurator
You can display customized process packages on the Feature settings page in WorkZone Configurator, so that an administrator can enable or disable packages in the same way as standard packages.
To display packages, you need to specify the following elements in the <PackageDefinition> section of the package.xml file:
<FeatureName>— The name of the process package.- <ParentFeatureName> — Adds the process package under this node on the Feature settings page. For example,
<ParentFeatureName>PROCESS</ParentFeatureName>adds the package under the WorkZone Process node. <FeatureSelectable>— J or N specifies whether the package can be activated or not. J specifies 'yes' and N specifies 'no'.<PackageDefaultEnabled>— J or N specifies whether the package will be installed by default on a new installation or not. J specifies 'yes' and N specifies 'no'.
You can also use WorkZone Configurator to add the package, see Add or update a process package in the WorkZone Configurator Guide.
See also Activate process packages in this guide and Feature settings in the WorkZone Configurator Administrator Guide.
